<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NumCpp: PybindInterface.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NumCppLogoDoxygen.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">NumCpp
   &#160;<span id="projectnumber">2.4.0</span>
   </div>
   <div id="projectbrief">A Templatized Header Only C++ Implementation of the Python NumPy Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_pybind_interface_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">PybindInterface.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_pybind_interface_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#ifdef INCLUDE_PYBIND_PYTHON_INTERFACE</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_error_8hpp.html">NumCpp/Core/Internal/Error.hpp</a>&quot;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_core_2_shape_8hpp.html">NumCpp/Core/Shape.hpp</a>&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_nd_array_8hpp.html">NumCpp/NdArray.hpp</a>&quot;</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">#include &quot;pybind11/pybind11.h&quot;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#include &quot;pybind11/numpy.h&quot;</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacenc.html">nc</a></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;{</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html">   44</a></span>&#160;    <span class="keyword">namespace </span>pybindInterface</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    {</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19">   47</a></span>&#160;        <span class="keyword">enum class</span> <a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19">ReturnPolicy</a> { <a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19ae8606d021da140a92c7eba8d9b8af84f">COPY</a>, <a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19adcd320d017d7f3c317bc8b234287bc9f">REFERENCE</a>, <a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19a9419303c1fae01a65adc8d1835aa2c6d">TAKE_OWNERSHIP</a> };</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html#abde82685837c3645f506b0800472ffbc">   49</a></span>&#160;        <span class="keyword">static</span> <span class="keyword">const</span> std::map&lt;ReturnPolicy, std::string&gt; <a class="code" href="namespacenc_1_1pybind_interface.html#abde82685837c3645f506b0800472ffbc">returnPolicyStringMap</a> = { {<a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19ae8606d021da140a92c7eba8d9b8af84f">ReturnPolicy::COPY</a>, <span class="stringliteral">&quot;COPY&quot;</span>},</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;        {<a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19adcd320d017d7f3c317bc8b234287bc9f">ReturnPolicy::REFERENCE</a>, <span class="stringliteral">&quot;REFERENCE&quot;</span>},</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        {<a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19a9419303c1fae01a65adc8d1835aa2c6d">ReturnPolicy::TAKE_OWNERSHIP</a>, <span class="stringliteral">&quot;TAKE_OWNERSHIP&quot;</span>} };</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        <span class="keyword">template</span>&lt;<span class="keyword">typename</span> dtype&gt;</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html#adfe4a3d878913657435705edfb3c331d">   54</a></span>&#160;        <span class="keyword">using</span> <a class="code" href="namespacenc_1_1pybind_interface.html#adfe4a3d878913657435705edfb3c331d">pbArray</a> = pybind11::array_t&lt;dtype, pybind11::array::c_style&gt;;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html#a92c5b0b49fb9d54b885582f85ff25d4f">   55</a></span>&#160;        <span class="keyword">using</span> <a class="code" href="namespacenc_1_1pybind_interface.html#a92c5b0b49fb9d54b885582f85ff25d4f">pbArrayGeneric</a> = pybind11::array;</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        <span class="comment">//============================================================================</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"></span>        <span class="keyword">template</span>&lt;<span class="keyword">typename</span> dtype&gt;</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html#ab473eb4036fcf02ed3c15342956cc9db">   66</a></span>&#160;        <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a> <a class="code" href="namespacenc_1_1pybind_interface.html#ab473eb4036fcf02ed3c15342956cc9db">pybind2nc</a>(<a class="code" href="namespacenc_1_1pybind_interface.html#adfe4a3d878913657435705edfb3c331d">pbArray&lt;dtype&gt;</a>&amp; numpyArray)</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        {</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;            <span class="keyword">const</span> <span class="keyword">auto</span> dataPtr = numpyArray.mutable_data();</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;            <span class="keywordflow">switch</span> (numpyArray.ndim())</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;            {</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;                <span class="keywordflow">case</span> 0:</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;                {</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>(dataPtr, 0, 0, <span class="keyword">false</span>);</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;                }</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;                <span class="keywordflow">case</span> 1:</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;                {</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;                    <span class="keyword">const</span> <a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a> <a class="code" href="namespacenc.html#a25f36ba02112a206936fae22b0724bb9">size</a> = <span class="keyword">static_cast&lt;</span><a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a><span class="keyword">&gt;</span>(numpyArray.size());</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>(dataPtr, 1, <a class="code" href="namespacenc.html#a25f36ba02112a206936fae22b0724bb9">size</a>, <span class="keyword">false</span>);</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;                }</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;                <span class="keywordflow">case</span> 2:</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;                {</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;                    <span class="keyword">const</span> <a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a> numRows = <span class="keyword">static_cast&lt;</span><a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a><span class="keyword">&gt;</span>(numpyArray.shape(0));</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;                    <span class="keyword">const</span> <a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a> numCols = <span class="keyword">static_cast&lt;</span><a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a><span class="keyword">&gt;</span>(numpyArray.shape(1));</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>(dataPtr, numRows, numCols, <span class="keyword">false</span>);</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;                }</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;                <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;                {</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;                    <a class="code" href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a>(<span class="stringliteral">&quot;input array must be no more than 2 dimensional.&quot;</span>);</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;                    <span class="keywordflow">return</span> {};</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;                }</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;            }</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;        }</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        <span class="comment">//============================================================================</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"></span>        <span class="keyword">template</span>&lt;<span class="keyword">typename</span> dtype&gt;</div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html#a1bbfbfcb2ba31e4364d101820bfc2ff8">  103</a></span>&#160;        <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a> <a class="code" href="namespacenc_1_1pybind_interface.html#a1bbfbfcb2ba31e4364d101820bfc2ff8">pybind2nc_copy</a>(<span class="keyword">const</span> <a class="code" href="namespacenc_1_1pybind_interface.html#adfe4a3d878913657435705edfb3c331d">pbArray&lt;dtype&gt;</a>&amp; numpyArray)</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        {</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;            <span class="keyword">const</span> <span class="keyword">auto</span> dataPtr = numpyArray.<a class="code" href="classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49">data</a>();</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;            <span class="keywordflow">switch</span> (numpyArray.ndim())</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;            {</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;                <span class="keywordflow">case</span> 0:</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;                {</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>(dataPtr, 0, 0);</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;                }</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;                <span class="keywordflow">case</span> 1:</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;                {</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;                    <span class="keyword">const</span> <a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a> <a class="code" href="namespacenc.html#a25f36ba02112a206936fae22b0724bb9">size</a> = <span class="keyword">static_cast&lt;</span><a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a><span class="keyword">&gt;</span>(numpyArray.size());</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>(dataPtr, 1, <a class="code" href="namespacenc.html#a25f36ba02112a206936fae22b0724bb9">size</a>);</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;                }</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;                <span class="keywordflow">case</span> 2:</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;                {</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;                    <span class="keyword">const</span> <a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a> numRows = <span class="keyword">static_cast&lt;</span><a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a><span class="keyword">&gt;</span>(numpyArray.shape(0));</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;                    <span class="keyword">const</span> <a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a> numCols = <span class="keyword">static_cast&lt;</span><a class="code" href="namespacenc.html#af0f49663fb63332596e2e6327009d581">uint32</a><span class="keyword">&gt;</span>(numpyArray.shape(1));</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>(dataPtr, numRows, numCols);</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;                }</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;                <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;                {</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;                    <a class="code" href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a>(<span class="stringliteral">&quot;input array must be no more than 2 dimensional.&quot;</span>);</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;                    <span class="keywordflow">return</span> {};</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;                }</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;            }</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;        }</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        <span class="comment">//============================================================================</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"></span>        <span class="keyword">template</span>&lt;<span class="keyword">typename</span> dtype&gt;</div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html#adf2283c3c717906d9ddfbd73f3ab8927">  139</a></span>&#160;        <a class="code" href="namespacenc_1_1pybind_interface.html#a92c5b0b49fb9d54b885582f85ff25d4f">pbArrayGeneric</a> <a class="code" href="namespacenc_1_1pybind_interface.html#adf2283c3c717906d9ddfbd73f3ab8927">nc2pybind</a>(<span class="keyword">const</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>&amp; inArray) </div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;        {</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;            <span class="keyword">const</span> <a class="code" href="classnc_1_1_shape.html">Shape</a> inShape = inArray.<a class="code" href="classnc_1_1_nd_array.html#a2d1b4adfe3c9897ffe3dca45e357b2b4">shape</a>();</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;            <span class="keyword">const</span> std::vector&lt;pybind11::ssize_t&gt; <a class="code" href="namespacenc.html#ae2b224742bc8263190d451a44ebe5e34">shape</a>{ <span class="keyword">static_cast&lt;</span>pybind11::ssize_t<span class="keyword">&gt;</span>(inShape.<a class="code" href="classnc_1_1_shape.html#a6f89f699dea6eb89eef19e00c92b223a">rows</a>), </div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;                <span class="keyword">static_cast&lt;</span>pybind11::ssize_t<span class="keyword">&gt;</span>(inShape.<a class="code" href="classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d">cols</a>) };</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;            <span class="keyword">const</span> std::vector&lt;pybind11::ssize_t&gt; strides{ <span class="keyword">static_cast&lt;</span>pybind11::ssize_t<span class="keyword">&gt;</span>(inShape.<a class="code" href="classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d">cols</a> * <span class="keyword">sizeof</span>(dtype)), </div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;                <span class="keyword">static_cast&lt;</span>pybind11::ssize_t<span class="keyword">&gt;</span>(<span class="keyword">sizeof</span>(dtype)) };</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;            <span class="keywordflow">return</span> <a class="code" href="namespacenc_1_1pybind_interface.html#a92c5b0b49fb9d54b885582f85ff25d4f">pbArrayGeneric</a>(<a class="code" href="namespacenc.html#ae2b224742bc8263190d451a44ebe5e34">shape</a>, strides, inArray.<a class="code" href="classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49">data</a>());</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;        }</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160; </div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;        <span class="comment">//============================================================================</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"></span>        <span class="keyword">template</span>&lt;<span class="keyword">typename</span> dtype&gt;</div>
<div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="namespacenc_1_1pybind_interface.html#a10c33cf2d4fc1d454901280f1a2dc861">  158</a></span>&#160;        <a class="code" href="namespacenc_1_1pybind_interface.html#a92c5b0b49fb9d54b885582f85ff25d4f">pbArrayGeneric</a> <a class="code" href="namespacenc_1_1pybind_interface.html#adf2283c3c717906d9ddfbd73f3ab8927">nc2pybind</a>(<a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>&amp; inArray, <a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19">ReturnPolicy</a> returnPolicy) </div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;        {</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;            <span class="keyword">const</span> <a class="code" href="classnc_1_1_shape.html">Shape</a> inShape = inArray.<a class="code" href="classnc_1_1_nd_array.html#a2d1b4adfe3c9897ffe3dca45e357b2b4">shape</a>();</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;            <span class="keyword">const</span> std::vector&lt;pybind11::ssize_t&gt; <a class="code" href="namespacenc.html#ae2b224742bc8263190d451a44ebe5e34">shape</a>{ <span class="keyword">static_cast&lt;</span>pybind11::ssize_t<span class="keyword">&gt;</span>(inShape.<a class="code" href="classnc_1_1_shape.html#a6f89f699dea6eb89eef19e00c92b223a">rows</a>), </div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;                <span class="keyword">static_cast&lt;</span>pybind11::ssize_t<span class="keyword">&gt;</span>(inShape.<a class="code" href="classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d">cols</a>) };</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;            <span class="keyword">const</span> std::vector&lt;pybind11::ssize_t&gt; strides{ <span class="keyword">static_cast&lt;</span>pybind11::ssize_t<span class="keyword">&gt;</span>(inShape.<a class="code" href="classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d">cols</a> * <span class="keyword">sizeof</span>(dtype)),</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;                <span class="keyword">static_cast&lt;</span>pybind11::ssize_t<span class="keyword">&gt;</span>(<span class="keyword">sizeof</span>(dtype)) };</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160; </div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;            <span class="keywordflow">switch</span> (returnPolicy)</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;            {</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;                <span class="keywordflow">case</span> <a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19ae8606d021da140a92c7eba8d9b8af84f">ReturnPolicy::COPY</a>:</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;                {</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="namespacenc_1_1pybind_interface.html#adf2283c3c717906d9ddfbd73f3ab8927">nc2pybind</a>(inArray);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;                }</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;                <span class="keywordflow">case</span> <a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19adcd320d017d7f3c317bc8b234287bc9f">ReturnPolicy::REFERENCE</a>:</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;                {</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;                    <span class="keyword">typename</span> pybind11::capsule reference(inArray.<a class="code" href="classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49">data</a>(), [](<span class="keywordtype">void</span>* <span class="comment">/*ptr*/</span>) {});</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="namespacenc_1_1pybind_interface.html#a92c5b0b49fb9d54b885582f85ff25d4f">pbArrayGeneric</a>(<a class="code" href="namespacenc.html#ae2b224742bc8263190d451a44ebe5e34">shape</a>, strides, inArray.<a class="code" href="classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49">data</a>(), reference);</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;                }</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;                <span class="keywordflow">case</span> <a class="code" href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19a9419303c1fae01a65adc8d1835aa2c6d">ReturnPolicy::TAKE_OWNERSHIP</a>:</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;                {</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;                    <span class="keyword">typename</span> pybind11::capsule garbageCollect(inArray.<a class="code" href="classnc_1_1_nd_array.html#ade07629d4094244f1dfca863af67e7c0">dataRelease</a>(),</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;                        [](<span class="keywordtype">void</span>* ptr)</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;                        {</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;                            dtype* dataPtr = reinterpret_cast&lt;dtype*&gt;(ptr);</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;                            delete[] dataPtr;</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;                        }</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;                    );</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;                    <span class="keywordflow">return</span> <a class="code" href="namespacenc_1_1pybind_interface.html#a92c5b0b49fb9d54b885582f85ff25d4f">pbArrayGeneric</a>(<a class="code" href="namespacenc.html#ae2b224742bc8263190d451a44ebe5e34">shape</a>, strides, inArray.<a class="code" href="classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49">data</a>(), garbageCollect);</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;                }</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;                <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;                {</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;                    std::stringstream sstream;</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;                    sstream &lt;&lt; <span class="stringliteral">&quot;ReturnPolicy &quot;</span> &lt;&lt; <a class="code" href="namespacenc_1_1pybind_interface.html#abde82685837c3645f506b0800472ffbc">returnPolicyStringMap</a>.at(returnPolicy) &lt;&lt; <span class="stringliteral">&quot; has not been implemented yet&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;                    <a class="code" href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a>(sstream.str());</div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;                }</div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;            }</div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;        }</div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;    }</div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;}</div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassnc_1_1_nd_array_html_a2d1b4adfe3c9897ffe3dca45e357b2b4"><div class="ttname"><a href="classnc_1_1_nd_array.html#a2d1b4adfe3c9897ffe3dca45e357b2b4">nc::NdArray::shape</a></div><div class="ttdeci">Shape shape() const noexcept</div><div class="ttdef"><b>Definition:</b> NdArrayCore.hpp:4356</div></div>
<div class="ttc" id="anamespacenc_html_a25f36ba02112a206936fae22b0724bb9"><div class="ttname"><a href="namespacenc.html#a25f36ba02112a206936fae22b0724bb9">nc::size</a></div><div class="ttdeci">uint32 size(const NdArray&lt; dtype &gt; &amp;inArray) noexcept</div><div class="ttdef"><b>Definition:</b> size.hpp:45</div></div>
<div class="ttc" id="a_error_8hpp_html"><div class="ttname"><a href="_error_8hpp.html">Error.hpp</a></div></div>
<div class="ttc" id="anamespacenc_html_ae2b224742bc8263190d451a44ebe5e34"><div class="ttname"><a href="namespacenc.html#ae2b224742bc8263190d451a44ebe5e34">nc::shape</a></div><div class="ttdeci">Shape shape(const NdArray&lt; dtype &gt; &amp;inArray) noexcept</div><div class="ttdef"><b>Definition:</b> Functions/Shape.hpp:44</div></div>
<div class="ttc" id="aclassnc_1_1_nd_array_html"><div class="ttname"><a href="classnc_1_1_nd_array.html">nc::NdArray&lt; dtype &gt;</a></div></div>
<div class="ttc" id="anamespacenc_html_af0f49663fb63332596e2e6327009d581"><div class="ttname"><a href="namespacenc.html#af0f49663fb63332596e2e6327009d581">nc::uint32</a></div><div class="ttdeci">std::uint32_t uint32</div><div class="ttdef"><b>Definition:</b> Types.hpp:40</div></div>
<div class="ttc" id="a_nd_array_8hpp_html"><div class="ttname"><a href="_nd_array_8hpp.html">NdArray.hpp</a></div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_a0ca16a67f36ad5d1960cd9567208ed19"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19">nc::pybindInterface::ReturnPolicy</a></div><div class="ttdeci">ReturnPolicy</div><div class="ttdoc">Enum for the pybind array return policy.</div><div class="ttdef"><b>Definition:</b> PybindInterface.hpp:47</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_a0ca16a67f36ad5d1960cd9567208ed19ae8606d021da140a92c7eba8d9b8af84f"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19ae8606d021da140a92c7eba8d9b8af84f">nc::pybindInterface::ReturnPolicy::COPY</a></div><div class="ttdeci">@ COPY</div></div>
<div class="ttc" id="aclassnc_1_1_nd_array_html_ade07629d4094244f1dfca863af67e7c0"><div class="ttname"><a href="classnc_1_1_nd_array.html#ade07629d4094244f1dfca863af67e7c0">nc::NdArray::dataRelease</a></div><div class="ttdeci">pointer dataRelease() noexcept</div><div class="ttdef"><b>Definition:</b> NdArrayCore.hpp:2574</div></div>
<div class="ttc" id="aclassnc_1_1_shape_html"><div class="ttname"><a href="classnc_1_1_shape.html">nc::Shape</a></div><div class="ttdoc">A Shape Class for NdArrays.</div><div class="ttdef"><b>Definition:</b> Core/Shape.hpp:40</div></div>
<div class="ttc" id="aclassnc_1_1_shape_html_aae1a3c997648aacaefb60d0e6d0bf10d"><div class="ttname"><a href="classnc_1_1_shape.html#aae1a3c997648aacaefb60d0e6d0bf10d">nc::Shape::cols</a></div><div class="ttdeci">uint32 cols</div><div class="ttdef"><b>Definition:</b> Core/Shape.hpp:45</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_abde82685837c3645f506b0800472ffbc"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#abde82685837c3645f506b0800472ffbc">nc::pybindInterface::returnPolicyStringMap</a></div><div class="ttdeci">static const std::map&lt; ReturnPolicy, std::string &gt; returnPolicyStringMap</div><div class="ttdef"><b>Definition:</b> PybindInterface.hpp:49</div></div>
<div class="ttc" id="a_core_2_shape_8hpp_html"><div class="ttname"><a href="_core_2_shape_8hpp.html">Shape.hpp</a></div></div>
<div class="ttc" id="anamespacenc_html"><div class="ttname"><a href="namespacenc.html">nc</a></div><div class="ttdef"><b>Definition:</b> Coordinate.hpp:44</div></div>
<div class="ttc" id="aclassnc_1_1_nd_array_html_a3df9d88c710b83f211f67dd4511b4f49"><div class="ttname"><a href="classnc_1_1_nd_array.html#a3df9d88c710b83f211f67dd4511b4f49">nc::NdArray::data</a></div><div class="ttdeci">pointer data() noexcept</div><div class="ttdef"><b>Definition:</b> NdArrayCore.hpp:2552</div></div>
<div class="ttc" id="aclassnc_1_1_shape_html_a6f89f699dea6eb89eef19e00c92b223a"><div class="ttname"><a href="classnc_1_1_shape.html#a6f89f699dea6eb89eef19e00c92b223a">nc::Shape::rows</a></div><div class="ttdeci">uint32 rows</div><div class="ttdef"><b>Definition:</b> Core/Shape.hpp:44</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_adf2283c3c717906d9ddfbd73f3ab8927"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#adf2283c3c717906d9ddfbd73f3ab8927">nc::pybindInterface::nc2pybind</a></div><div class="ttdeci">pbArrayGeneric nc2pybind(const NdArray&lt; dtype &gt; &amp;inArray)</div><div class="ttdef"><b>Definition:</b> PybindInterface.hpp:139</div></div>
<div class="ttc" id="a_error_8hpp_html_af2aff1172060367b9c5398fa097fa8fd"><div class="ttname"><a href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a></div><div class="ttdeci">#define THROW_INVALID_ARGUMENT_ERROR(msg)</div><div class="ttdef"><b>Definition:</b> Error.hpp:36</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_a1bbfbfcb2ba31e4364d101820bfc2ff8"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#a1bbfbfcb2ba31e4364d101820bfc2ff8">nc::pybindInterface::pybind2nc_copy</a></div><div class="ttdeci">NdArray&lt; dtype &gt; pybind2nc_copy(const pbArray&lt; dtype &gt; &amp;numpyArray)</div><div class="ttdef"><b>Definition:</b> PybindInterface.hpp:103</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_a0ca16a67f36ad5d1960cd9567208ed19a9419303c1fae01a65adc8d1835aa2c6d"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19a9419303c1fae01a65adc8d1835aa2c6d">nc::pybindInterface::ReturnPolicy::TAKE_OWNERSHIP</a></div><div class="ttdeci">@ TAKE_OWNERSHIP</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_adfe4a3d878913657435705edfb3c331d"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#adfe4a3d878913657435705edfb3c331d">nc::pybindInterface::pbArray</a></div><div class="ttdeci">pybind11::array_t&lt; dtype, pybind11::array::c_style &gt; pbArray</div><div class="ttdef"><b>Definition:</b> PybindInterface.hpp:54</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_a92c5b0b49fb9d54b885582f85ff25d4f"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#a92c5b0b49fb9d54b885582f85ff25d4f">nc::pybindInterface::pbArrayGeneric</a></div><div class="ttdeci">pybind11::array pbArrayGeneric</div><div class="ttdef"><b>Definition:</b> PybindInterface.hpp:55</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_ab473eb4036fcf02ed3c15342956cc9db"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#ab473eb4036fcf02ed3c15342956cc9db">nc::pybindInterface::pybind2nc</a></div><div class="ttdeci">NdArray&lt; dtype &gt; pybind2nc(pbArray&lt; dtype &gt; &amp;numpyArray)</div><div class="ttdef"><b>Definition:</b> PybindInterface.hpp:66</div></div>
<div class="ttc" id="anamespacenc_1_1pybind_interface_html_a0ca16a67f36ad5d1960cd9567208ed19adcd320d017d7f3c317bc8b234287bc9f"><div class="ttname"><a href="namespacenc_1_1pybind_interface.html#a0ca16a67f36ad5d1960cd9567208ed19adcd320d017d7f3c317bc8b234287bc9f">nc::pybindInterface::ReturnPolicy::REFERENCE</a></div><div class="ttdeci">@ REFERENCE</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_34171bd951b13a53aa9f237277a18e40.html">NumCpp</a></li><li class="navelem"><a class="el" href="dir_5de075070a423c280ad6ed943802bf75.html">PythonInterface</a></li><li class="navelem"><a class="el" href="_pybind_interface_8hpp.html">PybindInterface.hpp</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
  </ul>
</div>
</body>
</html>
